Skip to content

Redesign the README: banner, explorer walkthrough, flow card and status - #27

Merged
operatoruplift merged 3 commits into
mainfrom
claude/readme-redesign
Oct 31, 2026
Merged

operatoruplift merged 3 commits into
mainfrom
claude/readme-redesign

Conversation

@operatoruplift

@operatoruplift operatoruplift commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

What changed

The README was a long verification document with no visuals. This rebuilds it in the same house style as the Allowance README, so Buffer, Lotline, RWA Lens and Allowance read as one family, in Buffer's own cobalt.

  • Header: banner, three buttons (Open the explorer, Watch the films, Read the risk model), CI, site and stack badges, the landing page's own line, the Choose → Read → Move prices → Explain → Report loop, and section links.
  • Screens card: four real explorer screens with the built-in sample portfolio (the workspace, a -10% move adding up to +1,000 USDC, the Method panel, and a saved device report), rendered for light and dark themes.
  • How it works: a You → Buffer → Providers flow card, three guarantees, and the formula and worked examples kept in full. The complete boundaries and the five-step usage guide move into collapsible sections, word for word where they were operational.
  • Providers: Velocity, Pacifica, Jupiter Perps and legacy Drift in one table (what is read, how it is modeled), plus three phone screens reused from the repository's own dApp Store listing kit (no new image files).
  • Status: LIVE, DRY RUN, GATED, VALIDATING and HACKATHON rows, each scoped to a dated record in the docs: no outbound alert delivery, store release, public signup or event submission is claimed.
  • Run it locally: prerequisites, the run commands, everything CI runs (including the six PGlite database checks the old README did not mention), and one configuration table covering every variable in .env.example. Deploy notes, limits and safety, architecture and source map, and brand, films and design move into collapsible sections.
  • Documentation: every doc the old README linked, plus the release, reliability and listing records, grouped in one table. A script check confirms all 25 links from the old README are still present (one was corrected, below).

Fixes, each checked against the code:

  • The RVAClassic link pointed at x.com/operatoruplift; it now points at x.com/rvaclassic.
  • "Next.js 16.3.4" contradicted package.json and the lockfile, which pin 16.4.3 (the build reports 16.4.3).
  • "The process cap is 60 reads/minute and four concurrent reads" predates the last release. src/server/live-read-budget.ts now allows 30 reads a minute per client, 240 a minute and 8 in flight per instance, with a five-second cache for identical reads.
  • "30-second RPC function limits": the account and snapshot routes allow 30 seconds, but the monitoring check and worker routes allow 60.
  • "15 individually composed profile images" read as fifteen profiles; the kit holds 15 composed images, of which two are profiles.
  • The stale "Last updated: September 16, 2026." line is dropped (the statements that need dates now carry their own), and the README's one em dash is gone.
  • package.json gains description, homepage and repository (separate commit; the lockfile is unaffected).

Screenshots come from a local production build on Node 24.16.0 (npm run build and next start, no RPC or Supabase settings), using the app's built-in sample portfolio and its fixed reference snapshot, so no live account was read. The three phone screens come from docs/dapp-store/screenshots, captured from the live site by scripts/generate-dapp-store-assets.mjs; the Velocity screens show observations dated 8 October 2026. All new images live in docs/readme/ (five PNGs, about 1.2 MB).

Checks

All run on Node 24.16.0 with npm 11, as in CI.

  • npm ci: installed 1,193 packages.
  • npm run lint: passed.
  • npm run typecheck: passed.
  • npm test: 32 files, 673 tests passed.
  • The six CI database checks with PGlite 0.5.8 all passed: verify-alert-schema (55 assertions), verify-hosted-monitoring (113), verify-monitoring-scheduler (32), verify-account-deletion (27), verify-rate-limit (82) and verify-saved-report-quota (18), with no external writes.
  • npm run build: passed (Next.js 16.4.3).
  • Not run here: the Playwright browser suite (npm run test:e2e), which CI runs on every push and pull request; this PR changes no application code.
  • README check: no broken relative links or anchors, alt text on every image, no em or en dashes. Previewed in GitHub's light and dark layouts.
  • When this branch was pushed, GitHub reported 7 Dependabot alerts on main (4 high, 3 moderate). Dependency changes are out of scope here.

Suggested repository settings

These live outside the code, so they are not in this PR:

  • Homepage: the field says https://buffer-lovat.vercel.app, which docs/DEPLOYMENT.md keeps only "during the alias transition". The canonical address is https://bufferonsolana.vercel.app: it is SITE_URL in src/app/site.ts, the Vercel production alias, the Android shell's WEB_SHELL_URL, the dApp Store listing's website, and the operatoruplift profile link. Consider switching the homepage to it.
  • Description: the current one joins "transparent calculations" and "on any screen" with an em dash. A dash-free version: "Every position, every price move. Read-only scenarios for Solana perpetual positions, with clear coverage and transparent calculations on any screen."
  • Topics: the repository has none. Consider solana, perpetuals, perps, risk, velocity, pacifica, jupiter, defi, nextjs, pwa and solana-mobile.
  • Social preview: upload docs/readme/banner.png (2400 × 1200) under Settings → General → Social preview.

https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5


Generated by Claude Code

- Add a banner, explorer walkthrough and flow cards (light and dark)
  rendered from a local production build in docs/readme/, using the
  app's built-in sample portfolio
- Restructure into How it works, Providers, Status, Run it locally and
  Documentation; deploy notes, limits, architecture and brand material
  move into collapsible sections
- Fix stale facts: Next.js 16.3.4 (the lockfile pins 16.4.3), the live
  read limits (now 30 a minute per client, 240 a minute and 8 in flight
  per instance, with a five-second cache), the 30-second route limit
  (the monitoring check and worker routes allow 60), and the brand kit
  count (15 images, not 15 profile images)
- Fix the RVAClassic link (it pointed at x.com/operatoruplift), drop
  the stale "Last updated September 16" line and the em dashes, and add
  the six PGlite database checks CI runs to the local steps

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
- Homepage is SITE_URL in src/app/site.ts, the canonical production
  alias; the lockfile is unaffected

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
@vercel

vercel Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
buffer Ready Ready Preview Oct 30, 2026 8:53pm UTC

Request Review

- Only the two Velocity screens carry the 8 October 2026 observation
  time; the Pacifica caption now says what that screen shows

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01TZhsuWjATuivuiFYJGpbY5
@operatoruplift
operatoruplift merged commit 5bf5d7d into main Oct 31, 2026
5 checks passed

This branch was successfully deployed

1 active deployment
Preview — 6046209f Deployed Oct 30, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants